Skip to content

docs: fix helm install prometheus command #3563

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix helm install prometheus command #3563

wants to merge 1 commit into from
+2 −2

Conversation

@cr7258
Copy link

@cr7258 cr7258 commented Oct 11, 2025 •
edited by coderabbitai bot
Loading

Overview:

Fix Prometheus installation error caused by Helm interpreting {} as an array in --set parameters. Switched to --set-json to ensure podMonitorNamespaceSelector and probeNamespaceSelector are correctly parsed as objects.

helm install prometheus -n monitoring --create-namespace prometheus-community/kube-prometheus-stack \
  --set prometheus.prometheusSpec.podMonitorSelectorNilUsesHelmValues=false \
  --set prometheus.prometheusSpec.podMonitorNamespaceSelector="{}" \
  --set prometheus.prometheusSpec.probeNamespaceSelector="{}"
.....
Error: INSTALLATION FAILED: 1 error occurred:
        * Prometheus.monitoring.coreos.com "prometheus-kube-prometheus-prometheus" is invalid: 
        [spec.probeNamespaceSelector: Invalid value: "array": spec.probeNamespaceSelector in body must be of type object: "array", spec.podMonitorNamespaceSelector: 
       Invalid value: "array": spec.podMonitorNamespaceSelector in body must be of type object: "array"]

Details:

Where should the reviewer start?

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

  • closes GitHub issue: #xxx

Summary by CodeRabbit

  • Documentation
    • Updated Kubernetes metrics installation instructions to use --set-json for namespace selectors in monitoring resources.
    • Improves accuracy and reliability of the Helm install command, reducing copy/paste and quoting issues.
    • Clarifies how to pass structured values during installation for smoother setup.

@copy-pr-bot
Copy link

copy-pr-bot bot commented Oct 11, 2025

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions
Copy link

github-actions bot commented Oct 11, 2025

👋 Hi cr7258! Thank you for contributing to ai-dynamo/dynamo.

Just a reminder: The NVIDIA Test Github Validation CI runs an essential subset of the testing framework to quickly catch errors.Your PR reviewers may elect to test the changes comprehensively before approving your changes.

🚀

@github-actions github-actions bot added the external-contribution Pull request is from an external contributor label Oct 11, 2025
@cr7258 cr7258 changed the title doc: fix helm install prometheus command docs: fix helm install prometheus command Oct 11, 2025
@github-actions github-actions bot added the docs label Oct 11, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 11, 2025

Walkthrough

Updated a Helm install command in docs to use --set-json for two namespace selector fields in PodMonitor/Probe configuration, replacing prior --set usage and representing values as empty JSON objects. No code, API, or control-flow changes.

Changes

Cohort / File(s) Summary
Docs — Helm command updates
docs/kubernetes/metrics.md		 Replaced --set with --set-json for PodMonitor and Probe namespace selectors; values set to {}.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I thump with glee at flags so fine,
From set to set-json—cleaner line!
Empty braces, tidy rows,
Charts deploy where logic flows.
Carrot raised—docs now shine. 🥕

Pre-merge checks

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The pull request description uses the required template headings but leaves the Details and Where should the reviewer start sections empty, so it does not fully document the changes made or guide the reviewer to the relevant file. Please fill in the Details section with a brief summary of the actual changes (switching to --set-json for podMonitorNamespaceSelector and probeNamespaceSelector in docs/kubernetes/metrics.md) and add a Where should the reviewer start section that points to the updated metrics.md file.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title succinctly indicates a documentation fix for the Helm install command specific to Prometheus, directly reflecting the main change in this pull request. It is concise, clear, and immediately informs a reviewer of the primary purpose without extraneous details.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 65cc533 and 644e995.

📒 Files selected for processing (1)
  • docs/kubernetes/metrics.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Build and Test - dynamo

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link

github-actions bot commented Nov 10, 2025

This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.

@github-actions github-actions bot added the Stale label Nov 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

docs external-contribution Pull request is from an external contributor size/XS Stale

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@cr7258